Skip to main content
GET
Get channel
Returns a single channel for the authenticated merchant. Use this endpoint when you already know the external id and need the current name, type, status, and CMS configuration without listing all channels.
Requires an access token with the channels:read scope. See Token to obtain a token.

Request

Replace {id} with the external channel identifier.

Response

The response wraps one channel object in data.

Path parameters

Channel object

Present only when cms_template_id is not null. Contains the resolved CMS template assigned to the channel.Each field in fields:

Error responses

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

External channel identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$

Response

200 - application/json

Ok

data
object